<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Keep types token filter | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'analysis-keep-types-tokenfilter.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/analysis-keep-types-tokenfilter.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/analysis-keep-types-tokenfilter.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/analysis-keep-types-tokenfilter.html" rel="nofollow" target="_blank">../en/analysis-keep-types-tokenfilter.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="analysis.html">Text analysis</a></span>
»
<span class="breadcrumb-link"><a href="analysis-tokenfilters.html">Token filter reference</a></span>
»
<span class="breadcrumb-node">Keep types token filter</span>
</div>
<div class="navheader">
<span class="prev">
<a href="analysis-hyp-decomp-tokenfilter.html">« Hyphenation decompounder token filter</a>
</span>
<span class="next">
<a href="analysis-keep-words-tokenfilter.html">Keep words token filter »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="analysis-keep-types-tokenfilter"></a>Keep types token filter<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/analysis/tokenfilters/keep-types-tokenfilter.asciidoc">edit</a>
</h2>
</div></div></div>

<p>Keeps or removes tokens of a specific type. For example, you can use this filter
to change <code class="literal">3 quick foxes</code> to <code class="literal">quick foxes</code> by keeping only <code class="literal">&lt;ALPHANUM&gt;</code>
(alphanumeric) tokens.</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<h3>Token types</h3>
<p>Token types are set by the <a class="xref" href="analysis-tokenizers.html" title="Tokenizer reference">tokenizer</a> when converting
characters to tokens. Token types can vary between tokenizers.</p>
<p>For example, the <a class="xref" href="analysis-standard-tokenizer.html" title="Standard Tokenizer"><code class="literal">standard</code></a> tokenizer can
produce a variety of token types, including <code class="literal">&lt;ALPHANUM&gt;</code>, <code class="literal">&lt;HANGUL&gt;</code>, and
<code class="literal">&lt;NUM&gt;</code>. Simpler analyzers, like the
<a class="xref" href="analysis-lowercase-tokenizer.html" title="Lowercase Tokenizer"><code class="literal">lowercase</code></a> tokenizer, only produce the <code class="literal">word</code>
token type.</p>
<p>Certain token filters can also add token types. For example, the
<a class="xref" href="analysis-synonym-tokenfilter.html" title="Synonym token filter"><code class="literal">synonym</code></a> filter can add the <code class="literal">&lt;SYNONYM&gt;</code> token
type.</p>
</div>
</div>
<p>This filter uses Lucene’s
<a href="https://lucene.apache.org/core/8_5_1/analyzers-common/org/apache/lucene/analysis/core/TypeTokenFilter.html" class="ulink" target="_top">TypeTokenFilter</a>.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="analysis-keep-types-tokenfilter-analyze-include-ex"></a>Include example<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/analysis/tokenfilters/keep-types-tokenfilter.asciidoc">edit</a>
</h3>
</div></div></div>
<p>The following <a class="xref" href="indices-analyze.html" title="Analyze API">analyze API</a> request uses the <code class="literal">keep_types</code>
filter to keep only <code class="literal">&lt;NUM&gt;</code> (numeric) tokens from <code class="literal">1 quick fox 2 lazy dogs</code>.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET _analyze
{
  "tokenizer": "standard",
  "filter": [
    {
      "type": "keep_types",
      "types": [ "&lt;NUM&gt;" ]
    }
  ],
  "text": "1 quick fox 2 lazy dogs"
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/935.console"></div>
<p>The filter produces the following tokens:</p>
<div class="pre_wrapper lang-text">
<pre class="programlisting prettyprint lang-text">[ 1, 2 ]</pre>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="analysis-keep-types-tokenfilter-analyze-exclude-ex"></a>Exclude example<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/analysis/tokenfilters/keep-types-tokenfilter.asciidoc">edit</a>
</h3>
</div></div></div>
<p>The following <a class="xref" href="indices-analyze.html" title="Analyze API">analyze API</a> request uses the <code class="literal">keep_types</code>
filter to remove <code class="literal">&lt;NUM&gt;</code> tokens from <code class="literal">1 quick fox 2 lazy dogs</code>. Note the <code class="literal">mode</code>
parameter is set to <code class="literal">exclude</code>.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET _analyze
{
  "tokenizer": "standard",
  "filter": [
    {
      "type": "keep_types",
      "types": [ "&lt;NUM&gt;" ],
      "mode": "exclude"
    }
  ],
  "text": "1 quick fox 2 lazy dogs"
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/936.console"></div>
<p>The filter produces the following tokens:</p>
<div class="pre_wrapper lang-text">
<pre class="programlisting prettyprint lang-text">[ quick, fox, lazy, dogs ]</pre>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="analysis-keep-types-tokenfilter-configure-parms"></a>Configurable parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/analysis/tokenfilters/keep-types-tokenfilter.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">types</code>
</span>
</dt>
<dd>
(Required, array of strings)
List of token types to keep or remove.
</dd>
<dt>
<span class="term">
<code class="literal">mode</code>
</span>
</dt>
<dd>
<p>
(Optional, string)
Indicates whether to keep or remove the specified token types.
Valid values are:
</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">include</code>
</span>
</dt>
<dd>
(Default) Keep only the specified token types.
</dd>
<dt>
<span class="term">
<code class="literal">exclude</code>
</span>
</dt>
<dd>
Remove the specified token types.
</dd>
</dl>
</div>
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="analysis-keep-types-tokenfilter-customize"></a>Customize and add to an analyzer<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/analysis/tokenfilters/keep-types-tokenfilter.asciidoc">edit</a>
</h3>
</div></div></div>
<p>To customize the <code class="literal">keep_types</code> filter, duplicate it to create the basis
for a new custom token filter. You can modify the filter using its configurable
parameters.</p>
<p>For example, the following <a class="xref" href="indices-create-index.html" title="Create index API">create index API</a> request
uses a custom <code class="literal">keep_types</code> filter to configure a new
<a class="xref" href="analysis-custom-analyzer.html" title="Create a custom analyzer">custom analyzer</a>. The custom <code class="literal">keep_types</code> filter
keeps only <code class="literal">&lt;ALPHANUM&gt;</code> (alphanumeric) tokens.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">PUT keep_types_example
{
  "settings": {
    "analysis": {
      "analyzer": {
        "my_analyzer": {
          "tokenizer": "standard",
          "filter": [ "extract_alpha" ]
        }
      },
      "filter": {
        "extract_alpha": {
          "type": "keep_types",
          "types": [ "&lt;ALPHANUM&gt;" ]
        }
      }
    }
  }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/937.console"></div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="analysis-hyp-decomp-tokenfilter.html">« Hyphenation decompounder token filter</a>
</span>
<span class="next">
<a href="analysis-keep-words-tokenfilter.html">Keep words token filter »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>